Skip to content

docs: comprehensive update of integration test documentation#214

Open
shawn-hurley wants to merge 1 commit intokonveyor:mainfrom
shawn-hurley:issue/issue-193
Open

docs: comprehensive update of integration test documentation#214
shawn-hurley wants to merge 1 commit intokonveyor:mainfrom
shawn-hurley:issue/issue-193

Conversation

@shawn-hurley
Copy link
Copy Markdown
Contributor

@shawn-hurley shawn-hurley commented Mar 26, 2026 •
edited
Loading

Audit all test documentation against actual code and fix numerous stale references accumulated as tests were added without doc updates.

fixes #193

Key corrections:

  • Unit test count: 48 -> 76 (add 5 undocumented test classes)
  • Integration sub-test count: 43 -> 47 (account for table-driven tests)
  • Query count: 40+ -> 47 (precise count from code)
  • PackageDeclarationSearch queries: 2 -> 8
  • test-project file count: 6-8 -> 19 (full listing)
  • JDT.LS version: fix stale 1.35.0/1.38.0 refs to 1.51.0
  • Fix useUIHarness: true -> false (match actual pom.xml)
  • Fix nonexistent doc path: integration/README.md -> docs/integration-tests.md
  • Fix go.mod dependency version: v0.4.0-alpha.1 -> v0.8.0

Clarify two-Dockerfile setup:

  • CI uses default Dockerfile (self-contained, builds JAR from source)
  • Local dev uses Dockerfile.test (requires pre-built JAR, pre-installs Go)
  • Add mvn install prerequisite to all local container build instructions
  • Remove unnecessary runtime golang install from Dockerfile.test commands

Other fixes:

  • Replace stale Phase 1/2/3 planning sections with completed milestones
  • Fix test assertions API (referenced nonexistent test_utils.go)
  • Replace fake expected output with actual Go test framework format
  • Clean up stale 1.18.0 comment in target platform file

Summary by CodeRabbit

  • Documentation

    • Updated test coverage documentation reflecting expanded test scope (48 to 76 tests) with additional test categories including AST visitors and symbol providers.
    • Updated JDT.LS server version information from 1.35.0 to 1.51.0.
    • Enhanced test project structure documentation with expanded Java file examples and new dependency coverage.

  • Chores

    • Updated configuration guidance for target platform dependencies.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 26, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

Documentation updates across test suite files reflecting JDT.LS version bump (1.35.0 → 1.51.0), expanded unit test count (48 → 76), updated test project structure with new Java files and dependencies, revised container build/run instructions distinguishing local and CI workflows, and adjusted integration test examples and expected outputs.

Changes

Cohort / File(s) Summary
Test Suite Documentation
java-analyzer-bundle.test/README.md, java-analyzer-bundle.test/docs/README.md, java-analyzer-bundle.test/docs/quick-reference.md, java-analyzer-bundle.test/docs/query-reference.md, java-analyzer-bundle.test/docs/test-projects.md		 Updated test counts, added new test class entries, expanded test project structure from 8 to 19 Java files with new JMS/JPA/JDBC/servlet examples, increased query execution count from 40+ to 47, clarified package coverage scope, and noted expanded test dependencies.
Integration Test Documentation
java-analyzer-bundle.test/docs/integration-tests.md		 Updated JDT.LS version to 1.51.0, expanded Go LSP client API surface documentation, revised container build/run instructions to use Dockerfile.test for local builds with pre-built JAR and default Dockerfile for CI, updated search example queries and expected results, modified function signature example, and refreshed Go test assertions to align with standard testing framework patterns. Updated github.com/konveyor/analyzer-lsp dependency from v0.4.0-alpha.1 to v0.8.0.
Build Configuration Comments
java-analyzer-bundle.tp/java-analyzer-bundle.target		 Removed outdated guidance and commented-out type="Target" location block regarding JDT.LS target platform dependencies, updated comments to clarify JDT.LS-related dependencies should resolve from standalone repositories instead.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 Test counts leap from forty-eight to seventy-six so spry,
New files bloom in projects—JPA, JMS reaching high,
Container builds split wisely: local test and CI,
With version bumps and assertions polished, tests can fly! 🚀

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main change: comprehensive documentation updates across multiple integration test files, reflecting current code state with updated test counts, dependencies, and clarified Docker setup.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@shawn-hurley
docs: comprehensive update of integration test documentation
8d9acdb 
Audit all test documentation against actual code and fix numerous
stale references accumulated as tests were added without doc updates.

Key corrections:
- Unit test count: 48 -> 76 (add 5 undocumented test classes)
- Integration sub-test count: 43 -> 47 (account for table-driven tests)
- Query count: 40+ -> 47 (precise count from code)
- PackageDeclarationSearch queries: 2 -> 8
- test-project file count: 6-8 -> 19 (full listing)
- JDT.LS version: fix stale 1.35.0/1.38.0 refs to 1.51.0
- Fix useUIHarness: true -> false (match actual pom.xml)
- Fix nonexistent doc path: integration/README.md -> docs/integration-tests.md
- Fix go.mod dependency version: v0.4.0-alpha.1 -> v0.8.0

Clarify two-Dockerfile setup:
- CI uses default Dockerfile (self-contained, builds JAR from source)
- Local dev uses Dockerfile.test (requires pre-built JAR, pre-installs Go)
- Add mvn install prerequisite to all local container build instructions
- Remove unnecessary runtime golang install from Dockerfile.test commands

Other fixes:
- Replace stale Phase 1/2/3 planning sections with completed milestones
- Fix test assertions API (referenced nonexistent test_utils.go)
- Replace fake expected output with actual Go test framework format
- Clean up stale 1.18.0 comment in target platform file

Signed-off-by: Shawn Hurley <shawn@hurley.page>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[docs] Update the integration test docs to be accurate

1 participant

@shawn-hurley